/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.collections;

import com.flickr.api.FlickrServiceException;
import com.flickr.api.people.User;
import java.util.List;

/**
 *
 * @author Fabien Barbero
 */
public interface CollectionsService {
    
    /**
     * Returns a tree (or sub tree) of collections belonging to a given user.
     * @param id                        The user.
     * @return                          The collections at the first level.
     * @throws FlickrServiceException   Error getting the collections.
     */
    List<Collection> getTreeCollections(User id) throws FlickrServiceException;
    
    /**
     * Returns a tree (or sub tree) of collections belonging to a given user.
     * @param parent                    The collection to fetch a tree for.
     * @param id                        The user.
     * @return                          The collections at the first level.
     * @throws FlickrServiceException   Error getting the collections.
     */
    List<Collection> getTreeCollections(Collection parent, User id) throws FlickrServiceException;
    
    /**
     * Returns information for a single collection.
     * Currently can only be called by the collection owner, this may change.
     * @param collection                The collection to fetch information for.
     * @param id                        The user.
     * @return                          The informations on the collection.
     * @throws FlickrServiceException   Error getting the informations.
     */
    CollectionInfo getCollectionInfo(Collection collection, User id) throws FlickrServiceException;
    
}
